| Package | hl7.cda.us.ccda |
| Resource Type | StructureDefinition |
| Id | USRealmDateTime |
| FHIR Version | R5 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda/StructureDefinition-USRealmDateTime.html |
| URL | http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime |
| Version | 4.0.0 |
| Status | draft |
| Date | 2025-06-26T21:09:45+00:00 |
| Name | USRealmDateTime |
| Title | US Realm Date and Time - Point in Time |
| Realm | us |
| Authority | hl7 |
| Description | The US Realm Clinical Document Date and Time datatype flavor records date and time information. If time is provided, it must include a time zone offset. This data type uses the same rules as US Realm Date and Time (Interval), but is used with elements having a datatype of TS. |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| Kind | logical |
| StructureDefinition | |
| USRealmHeader | US Realm Header |
| StructureDefinition | |
| TS | TS: PointInTime (V3 Data Type) |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition USRealmDateTime
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  TS | C | 1..* | TS | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @value Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: ts-shall-day, ts-should-minute |
 @value | 0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "USRealmDateTime",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
}
]
}
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
],
"url": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.10.20.22.5.4"
}
],
"version": "4.0.0",
"name": "USRealmDateTime",
"title": "US Realm Date and Time - Point in Time",
"status": "draft",
"date": "2025-06-26T21:09:45+00:00",
"publisher": "Health Level Seven",
"contact": [
{
"name": "HL7 International - Structured Documents",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description": "The US Realm Clinical Document Date and Time datatype flavor records date and time information. If time is provided, it must include a time zone offset.\n\nThis data type uses the same rules as US Realm Date and Time (Interval), but is used with elements having a datatype of TS.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "2.0.1-sd"
}
],
"element": [
{
"id": "TS",
"path": "TS",
"short": "Base for all types and resources",
"definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"min": 1,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "ts-shall-day",
"severity": "error",
"human": "**SHALL** be precise to at least the day",
"expression": "nullFlavor.exists() or value.toString().length() >= 10",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
},
{
"key": "ts-should-minute",
"severity": "warning",
"human": "**SHOULD** be precise to at least the minute",
"expression": "nullFlavor.exists() or value.toString().length() > 10",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TS.nullFlavor",
"path": "TS.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "TS.value",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString": "year-valid:tz-for-time"
}
],
"path": "TS.value",
"representation": [
"xmlAttr"
],
"definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"min": 0,
"max": "1",
"base": {
"path": "TS.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"
]
}
]
}
]
},
"differential": {
"element": [
{
"id": "TS",
"path": "TS",
"constraint": [
{
"key": "ts-shall-day",
"severity": "error",
"human": "**SHALL** be precise to at least the day",
"expression": "nullFlavor.exists() or value.toString().length() >= 10",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
},
{
"key": "ts-should-minute",
"severity": "warning",
"human": "**SHOULD** be precise to at least the minute",
"expression": "nullFlavor.exists() or value.toString().length() > 10",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
}
]
},
{
"id": "TS.value",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString": "year-valid:tz-for-time"
}
],
"path": "TS.value"
}
]
}
}